home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / file / mtool21.lha / MTool / Docs / MFind_GB.Doc < prev    next >
Encoding:
Text File  |  1994-12-23  |  6.1 KB  |  180 lines
  1.  
  2.  
  3.  
  4.                                MultiFind
  5.                                  V1.0
  6.                                25.4.1994
  7.                            - Public Domain -
  8.  
  9.                                 MANUAL
  10.  
  11.  
  12. 1. Introduction:
  13.  
  14. MultiFind is a "real" public domain program. There's no limitation
  15. on its use - change it, sell it, eat the disk, just like you want.
  16. If you want to spread it please include the source code and this
  17. manual.
  18.  
  19. You're using MFind on your own risk. I'm cannot be held liable
  20. for any damage caused by MFind. This includes user mistakes, system
  21. crashes and any side effects.
  22.  
  23. MFind has been written for the use with my directory utility MTool.
  24. But it can also be used "stand alone" or included in other programs.
  25.  
  26. Please report any bugs, so I can remove them!
  27.  
  28. If you improve MFind, please send me the result. This manual is a
  29. "quick and dirty" translation from the German docs. I didn't want
  30. to postpone the release of MTool 2.0c any longer by doing a more
  31. careful translation. Sorry for that.
  32.  
  33.                                                Boris Jakubaschk
  34.                                                Neue Straße 14/1
  35.                                                70186  Stuttgart
  36.                                                         Germany
  37.  
  38.                                                 ++49 711 462989
  39.  
  40.                                               FIDO 2:246/1115.2
  41.                                 EMail Boris@alice.tynet.sub.org
  42.  
  43. Many thanks to:
  44.   - Matt Dillon for DICE
  45.   - Jan van den Baard for GadToolsBox
  46.  
  47.  
  48. 2. What is it good for?
  49.  
  50. Have you ever "lost" a file on your hard drive of even a disk?
  51. You remember it was a letter for aunt Mary - but what was the
  52. file name? Or you know it must be "MaryLetter3.TXT", but it
  53. has moved to a drawer where you would search it at last...
  54.  
  55. That's a job for MultiFind: You can look for file names (or
  56. patterns) or parts of the file contents. MFind searches in all
  57. directories you have selected, if necessary all over the hard
  58. disk. This is done very quickly, even while searching in
  59. files.
  60.  
  61. Everything is controlled by a graphical user interface. All
  62. files that match the search pattern are displayed in a list
  63. view. You can select entries from this list, transfer the
  64. path names to the clipboard or call an editor that displays
  65. the file and jumps to the word you have looked for. A future
  66. version of MTool will be able to use the results of MFind,
  67. too.
  68.  
  69.  
  70. 3. How to use it:
  71.  
  72. After having started MFind, you see a window with two big list
  73. views, a string gadget at the top and some other gadgets. The
  74. list view at the left side will display the file names that
  75. have been found, the other one holds the path names to search.
  76.  
  77. Let's start at the top of the window: The string gadget holds
  78. a file name pattern, an ASCII string or a sequence of bytes in
  79. hexadecimal notation, according to the cycle gadget behind it
  80. and the "HEX mode" switch below. The other switches are used
  81. as follows:
  82.  
  83. - only file names: Only active when searching for file names.
  84.       If selected, MFind compares the pattern only with the
  85.       file name, not with its path. If you input "#?info#?"
  86.       as a pattern, MFind will find "Work:taskinfo/main.c"
  87.       only if this switch is off, because "info" is a part
  88.       of the path and not of the file name.
  89. - case sensitive: If selected, MFind won't find files with
  90.       the right name but a different case of some chars.
  91. - subdirectories: Normally, all sub directories of the
  92.       selected directories are searched. To prevent this
  93.       (i.e. to search only in the base directory), this
  94.       switch must be off.
  95.  
  96. To select the directories to be searched, you must click on
  97. "New" on top of the right list view. A file requester will
  98. show up, where you can select the desired directory. If
  99. you want to remove an entry of this list, select it and
  100. click on "Del" then.
  101.  
  102. Now you are ready to start the search by pressing "Start".
  103. You can "Stop" it whenever you want. The names of all files
  104. that are found are displayed in the right list view. When
  105. starting a new search, the list is not cleared automatically.
  106. You can do this by pressing "Clear".
  107.  
  108.  
  109. 4. What now?
  110.  
  111. There are three options what to do with the file names
  112. displayed in the left list view. The belonging gadgets
  113. are below the list:
  114.  
  115. - MTool: The directory of the file is displayed in the
  116.      active file list and the file is selected. This will
  117.      be possible with MTool V2.2, because the ARexx port
  118.      is not yet implemented.
  119.  
  120. - Clipboard: The file name (including path) is put to
  121.      the clipboard, so you can paste it to a Shell with
  122.      Amiga-v.
  123.  
  124. - Editor: An editor is started, the file is loaded and the
  125.      cursor jumps to the position of the first occurrence of
  126.      the search string (if search has been for file contents).
  127.  
  128.  
  129. 5. Configuration
  130.  
  131. MultiFind can be adapted to your environment. When you start
  132. it from Workbench, you can use the following tool types. From
  133. Shell, you can put the tool type strings in the command line:
  134.  
  135. ED_Cmd=<file name>
  136.     - Name of the editor. Put a "%s" where MFind should insert
  137.       the file name. Default: "EDC %s".
  138.  
  139. ED_Port=<ARexx port>
  140.     - Name of the editors ARexx port. Default: "rexx_ced"
  141.  
  142. ED_RxCmd=<ARexx command>
  143.     - Arexx command to execute when jumping to the first
  144.       occurence of the search string. The offset must be
  145.       replaced by "%d". Default: "Jump to byte %d".
  146.  
  147. MT_Port=<ARexx port>
  148.     - unused. Default: "rexx_mtool".
  149.  
  150. MT_RxCmd=<ARexx command>
  151.     - unused. Default: "Get dir actual %s".
  152.  
  153. PATHSFILE=<file name>
  154.     - Text file containing the names of all paths to include
  155.       in the right list view at startup. So you can call MFind
  156.       quite easy from MTool. Just include it as a program object
  157.       with "PATHSFILE=%s" as the argument string. The argument
  158.       type must be set to "Source paths as file". MTool will
  159.       then pass all selected files and paths to MFind when you
  160.       call it.
  161.  
  162.  
  163. 6. History
  164.  
  165. V1.0  - 25.04.1994 (released together with MTool V2.0c)
  166.  
  167. NEW:
  168.  
  169. - Horizontal scrollers
  170.  
  171. Known bugs:
  172.  
  173. - Dir utility control theoretically implemented but untested
  174.   because MTool still has no ARexx port.
  175.  
  176. - Problems with GoldEd.
  177.  
  178.  
  179. V1.0ß - 12.03.1994 (unreleased)
  180.